Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace game manuals 1 & 2 with the new Competition Manual #295

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

miriamsr
Copy link
Member

@miriamsr miriamsr commented Aug 2, 2024

No description provided.

Copy link
Contributor

@alan412 alan412 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. We also need a pull request removing the field setup guide so the link check will pass. (this may wait until the ITD field setup guide is available)

@miriamsr
Copy link
Member Author

miriamsr commented Aug 2, 2024

@alan412 We also need to change all references to the "Game Manuals" page to be to the "Competition Manuals" page. I'm currently in the process of doing that. For the field setup guide, I'll probably just replace that link with a "coming soon" note since the check failing makes it annoying to merge PRs with content.

@uvidyadharan
Copy link
Member

@alan412 We also need to change all references to the "Game Manuals" page to be to the "Competition Manuals" page. I'm currently in the process of doing that. For the field setup guide, I'll probably just replace that link with a "coming soon" note since the check failing makes it annoying to merge PRs with content.

We also need to add it to the redirects list in the config

@miriamsr
Copy link
Member Author

miriamsr commented Aug 2, 2024

@uvidyadharan I'm not entirely sure what you mean. I can't seem to find any redirect list in conf.py. Was I looking in the wrong place?

@emcclurg emcclurg mentioned this pull request Aug 2, 2024
@uvidyadharan
Copy link
Member

Could you make sure to rename the game manual page to competition manual? @miriamsr

@miriamsr
Copy link
Member Author

Per the meeting today, I'm not sure if we want to keep the Competition Manual page with an embed at all. I see 3 options for how to proceed with this PR:
a) Redo the page to link to the manual without the embed and have some text encouraging teams to read the entire manual.
b) In every place where we currently reference the Competition Manual page, link directly to the PDF outside of ftc-docs.
c) Whenever we talk about something that the Competition Manual says, just give the rule number instead of a link.

@texasdiaz
Copy link
Contributor

Yeah, I'm thinking we should just have a central "Competition Resources" page with a listing of all the links that people need. There are a LOT of them.

Pages and Links:
FTC Blog - https://community.firstinspires.org/topic/ftc
FTC Q&A - https://ftc-qa.firstinspires.org/
FTC Game and Season Info - https://ftc.game
FTC Events site - https://ftc-events.firstinspires.org
FTC Technical Support - https://ftc-community.firstinspires.org
FTC Avatar Submission - https://ftc-scoring.firstinspires.org
FTC Docs - https://ftc-docs.firstinspires.org
(there are additional pages coming, like for volunteers)

Competition Specific Resources
All Resources - https://ftc.game
FTC Competition Manual - https://ftc-resources.firstinspires.org/file/ftc/game/manual
FTC Competition Manual (HTML) - https://ftc-resources.firstinspires.org/file/ftc/game/cm-html/Competition%20Manual%20-%20V1.1.htm
FTC Game One-Page Summary - https://ftc-resources.firstinspires.org/file/ftc/game/game-one-page

@miriamsr
Copy link
Member Author

I think that page is a good idea. One concern I have with linking the HTML version of the CM is that the URL has the version number in it, which means that someone would need to update this page every time a new version is released. It’s not a big deal, just something we need to remember that we need to do.

@rachmo
Copy link
Contributor

rachmo commented Sep 17, 2024

@texasdiaz where are you getting that html version # in the link?

I think this is the correct link and it will update with the versions https://ftc-resources.firstinspires.org/file/ftc/game/cm-html

@texasdiaz
Copy link
Contributor

I clicked the link on the resources page, and that's the page it sent me to (I just copy-pasted the link in the url bar). If anyone is going to bookmark a link, it's going to be the link in the URL bar and not the link they clicked to take them there that redirected you. Perhaps we need to talk to Jacob to see if we can obfuscate the link to make bookmarking better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants